From 28a961b70659cac9ec2eaee236a03f29d0510fc1 Mon Sep 17 00:00:00 2001 From: Keir Fraser Date: Tue, 1 Apr 2008 10:05:52 +0100 Subject: [PATCH] docs: Documentation for XSPolicy.can_run command Signed-off-by: Stefan Berger --- docs/xen-api/revision-history.tex | 11 ++++++++-- docs/xen-api/xenapi-coversheet.tex | 2 +- docs/xen-api/xenapi-datamodel.tex | 35 ++++++++++++++++++++++++++++++ 3 files changed, 45 insertions(+), 3 deletions(-) diff --git a/docs/xen-api/revision-history.tex b/docs/xen-api/revision-history.tex index d282adb106..cf4a211f62 100644 --- a/docs/xen-api/revision-history.tex +++ b/docs/xen-api/revision-history.tex @@ -23,12 +23,19 @@ \end{flushleft} \end{minipage}\\ \hline - 1.0.2 & 11th Feb. 08 & S. Berger & + 1.0.3 & 11th Feb. 08 & S. Berger & \begin{minipage}[t]{7cm} \begin{flushleft} Added table of contents and hyperlink cross reference. \end{flushleft} \end{minipage}\\ \hline + 1.0.4 & 23rd March 08 & S. Berger & + \begin{minipage}[t]{7cm} + \begin{flushleft} + Added XSPolicy.can\_run + \end{flushleft} + \end{minipage}\\ + \hline \end{tabular} -\end{center} \ No newline at end of file +\end{center} diff --git a/docs/xen-api/xenapi-coversheet.tex b/docs/xen-api/xenapi-coversheet.tex index c35190acfe..ab6f0e3eff 100644 --- a/docs/xen-api/xenapi-coversheet.tex +++ b/docs/xen-api/xenapi-coversheet.tex @@ -22,7 +22,7 @@ \newcommand{\releasestatement}{Stable Release} %% Document revision -\newcommand{\revstring}{API Revision 1.0.2} +\newcommand{\revstring}{API Revision 1.0.4} %% Document authors \newcommand{\docauthors}{ diff --git a/docs/xen-api/xenapi-datamodel.tex b/docs/xen-api/xenapi-datamodel.tex index 102b59e04c..a9ebaad545 100644 --- a/docs/xen-api/xenapi-datamodel.tex +++ b/docs/xen-api/xenapi-datamodel.tex @@ -14938,6 +14938,41 @@ Currently active instantiation flags. \vspace{0.3cm} \vspace{0.3cm} \vspace{0.3cm} +\subsubsection{RPC name:~can\_run} + +{\bf Overview:} +Check whether a VM with the given security label could run on the system. + + \noindent {\bf Signature:} +\begin{verbatim} int can_run (session_id s, string security_label)\end{verbatim} + + +\noindent{\bf Arguments:} + + +\vspace{0.3cm} +\begin{tabular}{|c|c|p{7cm}|} + \hline +{\bf type} & {\bf name} & {\bf description} \\ \hline +{\tt string } & security_label & reference to the object \\ \hline + +\end{tabular} + +\vspace{0.3cm} + + \noindent {\bf Return Type:} +{\tt +int +} + + +Error code indicating whether a VM with the given security label could run. +If zero, it can run. + +\vspace{0.3cm} + +\noindent{\bf Possible Error Codes:} {\tt SECURITY\_ERROR} + \subsubsection{RPC name:~get\_all} {\bf Overview:} -- 2.30.2